home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 007a / headv10c.zip / HEADLINE.DOC next >
Text File  |  1991-11-14  |  14KB  |  279 lines
  1. INTRODUCTION
  2.  
  3.    Hello and thank you for having a look at my latest project.
  4.  
  5.    Most if not all of you must currently use LIST or something similar to browse
  6. through the files provided in services.  HeadLiner has been designed to allow
  7. you to continue to use LIST (or whatever) for those files which HeadLiner
  8. doesn't understand while making it easier to read those which it does.  I was
  9. continuously annoyed by having to page through the entire file looking for
  10. interesting news items (and sports scores) and thus was born HeadLiner.  It
  11. started out as a standalone concept where I had to unpack the newsfeeds and
  12. then read them using HeadLiner.  You CAN still do it this way if you like but,
  13. it works much nicer when used with an OLMR that does the unpacking for you.
  14.  
  15.    Thank you Les Gyurky, for providing me with the hooks to get the integration
  16. started and for taking minutes out of the PMDBM development cycle to give
  17. HeadLiner a poke.  Thanks also to Eric Decker who picked up the gauntlet when
  18. PMDBM took all of Les' time for poking at HeadLiner.  I find it very useful and
  19. I hope you do to.
  20.  
  21. ===============================================================================
  22. ABOUT
  23.  
  24.                 HeadLiner  V1.04c    (c) 1991   Kevin Morwood
  25.  
  26.   This program is intended to make it simpler to read the newsfeeds you want
  27.   to read while skipping over the news you don't.  The news file is scanned
  28.   for headlines and these are put into a bar menu.  Once this is complete you
  29.   have an index to each and every article in the file without having to page
  30.   through the entire file.
  31.  
  32.   For example if you want to only read the Sports in the CPI news then you
  33.   simply cursor down to the sports entries and press RETURN.
  34.  
  35.   Currently HeadLiner supports the following newsfeeds:
  36.      CPITODAY
  37.      MicroBytes
  38.      Newsbytes
  39.      BBSNews
  40.  
  41.   I'm currently working on some expansions that will make HeadLiner even more
  42.   useful.  Toronto Computes is the biggest of these that I'm attempting now
  43.   but it is proving to be a difficult file to parse.  Stay tuned for new
  44.   updates.
  45.  
  46. ===============================================================================
  47. LICENSE
  48.  
  49.    HeadLiner is the property of Kevin Morwood.  You may use it in either of
  50. it's operating formats (standalone or inside of your OLMR), for evaluation
  51. purposes, for a period of 10 days.  If you find it useful you are obliged to
  52. register it with me after this period.  The registration fee for this release
  53. is $5.  I reserve the right to alter this amount for future releases as
  54. HeadLiner grows in capability.
  55.  
  56.    This program is provided for your use, as is.  I accept no liability for the
  57. use of this program.  You are using it at your own risk.  There are no known
  58. bugs that would cause system failures but it has not been tested on every
  59. possible platform.
  60.  
  61.    I can be reached on CRS in conference 2, 5 or 43.  Please let me know if you
  62. have any ideas for enhancments.
  63.  
  64. ===============================================================================
  65. INSTALLATION
  66.  
  67.    HeadLiner is designed to fit seamlessly into your regular OLMR setup.  As
  68. a consequence of this it MAY also be run from the regular DOS command line.
  69. This has to do with it being a LIST 'replacement'.
  70.    I have tested it with Deluxe² and PMDBM.  If you are using a different mail
  71. reader then let me know how it handles services and I'll look at how to connect
  72. it properly.
  73.  
  74.    To install it into PMDBM or Deluxe² you simply change the LIST utility in
  75. the configuration from
  76.  
  77.       LIST  <────┬(or whatever)
  78.                  │
  79. to               │
  80.                  
  81.       HEADLINE LIST
  82.  
  83. When you attempt to read a file that Headliner can parse then it will execute
  84. and provide HeadLiner features.  If HeadLiner cannot understand the file it
  85. terminates and sends the file onward to LIST.  That's all there is to it.
  86. Place the executable HEADLINE.EXE in the same directory as your reader
  87. executables or at least somewhere in your path.
  88.  
  89. From DOS:
  90.    If you wish to use HeadLiner outside of your OLMR type HEADLINE for the
  91. usage text.  You will have to unzip the news files yourself if you want to use
  92. it in this way.
  93.  
  94. ===============================================================================
  95. USE
  96.  
  97.    HeadLiner has prompts on screen whereever appropriate to indicate which keys
  98. do what.
  99.  
  100. ===============================================================================
  101. BUGS
  102.  
  103.    Occasionally a newsfeed file comes down from the source that doesn't quite
  104. conform to the recognized standard.  The program, being a parser, gets really
  105. confused and may even crash.  I'm working on some error trapping capabilities
  106. that will prevent this event.  Please let me know when something happens that
  107. isn't expected.  I'm active on CRS in the conferences mentioned above.
  108.  
  109.    In the event you get a file that causes HeadLiner to crash let me know which
  110. file.  I get all of my test files from CRS so I've likely got the one you're
  111. using.  I have been running HeadLiner since October with no file parsing errors.
  112. When new newsfeeds come down the pipe I usually test them thoroughly.
  113.  
  114. ===============================================================================
  115. HISTORY
  116.  
  117.           Aug-Sept 1991  - Tinkered with the idea and wrote the basic system
  118.                          - Figured out what the hooks required to add this to
  119.                            PMDBM or Deluxe² were.  Thanks go to Les Gyurky for
  120.                            his assistance.
  121.           Sept 28 1991   - Adjusted the colour scheme so that it appears to be
  122.                            a part of PMDBM.  Les' colour scheme is good so I'll
  123.                            follow it.
  124.           Oct 17 1991    - Some cleanup.  I realized that I had compiled the
  125.                            program with -f87 which meant that other people
  126.                            might not be able to run it if they didn't have a
  127.                            f.p. processor.
  128.                          - Finished PMDBMizing the colour.
  129.                          - Added capability to read NEWSBYTES newsfeeds
  130.                  V0.95   - Added scrolling menus.  The NewsBytes feed made
  131.                            this necessary since the file is so large and has
  132.                            so many articles in it.
  133.                          - did some general cleanup to try to find the bug
  134.                            described below.
  135.           Oct 18 1991  (very early in the morning)
  136.                  V0.96   - I fixed the file passing bug.  The program will now
  137.                            either parse the file as one that it knows how to
  138.                            parse or it will send it straight through to the
  139.                            list utility specified as argument #1.
  140.                          - fixed an apparent bug of leaving files open.  DOS
  141.                            hates this kind of stuff.
  142.                  V0.97   - fixed the very annoying *.* bug.  They are now
  143.                            treated as unknown files and sent straight to
  144.                            listUtil which must know how to handle them.
  145.           Oct 19 1991    - Fixed path look-up problem.  Wouldn't execute DOS
  146.                  V0.98     shell functions, since they're not in the path.
  147.                            and it was a bit annoying to always have to put the
  148.                            list utility in the path.  SO it looks first at the
  149.                            current directory, then at the path and finally
  150.                            DOS shell commands.
  151.                          - Removed the use of the list utility for reading the
  152.                            articles from the recognized newsfeeds.  This does
  153.                            two things...1) It speeds HEADLINER up IMMENSELY
  154.                            because it doesn't have to create all of those
  155.                            temporary files.  2) Makes it necessary for me to
  156.                            write a function in the program to allow for viewing
  157.                            of the article.  V1.00 here we come!
  158.           Oct 20 1991  (at my favourite time of the day)
  159.                  V1.00   - temporarily disabled the NewsBytes capabilities
  160.                            due to some strange problems resulting from the
  161.                            switch to the new file organization.
  162.                          - wrote the first incantation of the article browser.
  163.           Oct 30 1991
  164.                  V1.01   - Fixed the extra blank line insertion problem.  The
  165.                            article constructor was reading exactly 80
  166.                            characters and if the newline was in the 80th
  167.                            position then it appeared in a successive, empty
  168.                            line.  Forcing the reader to read more than 80
  169.                            characters per line fixed the problem.
  170.                          - Finally re-installed the NewBytes reader.  The
  171.                            NB files only have a linefeed while the others have
  172.                            carriage return AND linefeeds imbedded in the file.
  173.                          - Added a function to remove the leading blank lines
  174.                            from the reader.
  175.                          - The title now stays at the top of the screen for the
  176.                            entire read.
  177.           Nov 02 1991
  178.                  V1.02   - Won't load files that don't occur on the current
  179.                            disk.  This is a real problem for those who use
  180.                            scratch disks other than their home disks (ie. RAM
  181.                            drives).  Thanks go to Eric Decker for pointing this
  182.                            one out to me.
  183.                          - this caused some real seamy problems with PMDBM so
  184.                            I re-wrote the way that I find and open files.  It
  185.                            works much better now.  I don't know if it caused
  186.                            a problem with Deluxe².
  187.           Nov 03 1991
  188.                  V1.03   - Reworked the keyboard interface.  It was too
  189.                            complicated if I wanted to add any new keys to the
  190.                            control structure.
  191.                          - Added +/- keys to the reader section.  You can now
  192.                            press +/- to see next/previous article in the news
  193.                            file.
  194.           Nov 05 1991
  195.                          - fixed a rather peculiar memory allocation error.
  196.                          - Changed a few more key's functions.  ESC will now
  197.                            advance in the menu by one when leaving the reader.
  198.           Nov 06 1991
  199.                  V1.04   - BBSNews!
  200.                          - cleaned up the file determination.  New feeds should
  201.                            be easy now.
  202.           Nov 08 1991
  203.                          - Added some much needed error trapping to the
  204.                            scanner.  It will return to the LIST tool if there
  205.                            is no menu constructed after the scan.  This would
  206.                            normally result from the scanner never leaving the
  207.                            initial state.  If the file is SUPPOSED to be of the
  208.                            right format and it is not then it should fall
  209.                            through to the LIST tool.  No diagnostics are
  210.                            produced yet.  There will still be problems with
  211.                            indeterminant states if the scanner encounters some
  212.                            character that it doesn't know that causes the
  213.                            symbol to be 0.  This goes into an infinite loop.
  214.                            The fix for this is not obvious.
  215.           Nov 10 1991
  216.                  V1.04b  - Repairs to BBSNews scanning rules.
  217.                          - more error handling.
  218.           Nov 14 1991
  219.                  V1.04c  - Reader paging is fixed so that the last line of the
  220.                            current screen becomes the first line of the next.
  221.                          - The smooth scrolling of the text has been removed
  222.                            for purposes of the previous fix.
  223.                          - By popular demand I changed the reader text colour
  224.                            to white.
  225.  
  226. ===============================================================================
  227. REGISTRATION INFO
  228.  
  229.    HeadLiner V1.04c License fee:  $5.00
  230.  
  231.    Please make cheque or money order payable to:
  232.  
  233.    Kevin Morwood
  234.  
  235.    and mail it to:  (please include a copy of the registration form found
  236.                      at the bottom of this file.)
  237.  
  238.    Kevin Morwood
  239.    514 Lansdowne Ave. Apt. 2,
  240.    Toronto, Ontario,
  241.    M6H 3Y3
  242.  
  243. ==============================================================================
  244. REGISTRATION FORM
  245.  
  246. Your Name: _______________________________   Phone: ____________________
  247.  
  248. Address:   _______________________________     Network / Conference /
  249.                                                Username where you can
  250.            _______________________________     be reached:
  251.  
  252.            _______________________________   ___________________________
  253.  
  254.            _______________________________   ___________________________
  255.  
  256.    Country:_______________________________
  257.  
  258.  
  259. Off Line Mail Reader used:
  260.             PMDBM [ ]   Deluxe² [ ]
  261.             Other [ ] (specify) _________________________________________
  262.  
  263. Payment Method:  Cheque [ ]     Money Order [ ]
  264.                                                  TOTAL      QTY.
  265.  
  266. License fee            @ C$ 5.00 / $ 5.00US     $_______    ____
  267.  
  268.              SUBTOTAL                           $_______    ____
  269.  
  270.       Canadian residents add 7% GST             $_______    ____
  271.  
  272.       Ontario residents add  8% PST             $_______    ____
  273.  
  274.                   TOTAL                         $_______    ____
  275.  
  276.  
  277. -------------------------------------------------------------------------------
  278.  
  279.